Search results

Types

Classes
Interfaces
Enums
Functions
Type aliases
Constants

Members

Properties
Methods
Getters
Setters
Enum members
Show privates

Other

In this module only
index / detritus-client-socket / Socket_3

Class Socket

extends EventSpewerclass EventSpewerdetritus-utils/EventSpewer

Defined in gateway

Constructor

constructor(token: string, options: SocketOptionsinterface SocketOptionsdetritus-client-socket/SocketOptions = {})

Properties

state: SocketStatesenum SocketStatesdetritus-client-socket/SocketStates = SocketStates.CLOSEDenum SocketStatesdetritus-client-socket/SocketStates[src]
_heartbeat: {
ack: boolean,
lastAck: null | number,
lastSent: null | number,
interval: Intervalclass Intervaldetritus-utils/Interval,
intervalTime: null | number
} = {
ack: false,
lastAck: null,
lastSent: null,
interval: Intervalclass Intervaldetritus-utils/Interval,
intervalTime: null
}[src]
bucket: Bucketclass Bucketdetritus-client-socket/Bucket[src]
compress: CompressTypesenum CompressTypesdetritus-client-socket/CompressTypes[src]
discordTrace: Array<any>external Array = Array<never>external Array[src]
decompressor: Decompressorclass Decompressordetritus-client-socket/Decompressor | null[src]
encoding: EncodingTypesenum EncodingTypesdetritus-client-socket/EncodingTypes[src]
identifyProperties: IdentifyDataPropertiesinterface IdentifyDataPropertiesdetritus-client-socket/IdentifyDataProperties = Object.assign({}, IdentifyProperties)[src]
intents: number = GatewayIntentsenum GatewayIntentsdetritus-client-socket/GatewayIntents[src]
mediaGateways = BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Socketclass Socketdetritus-client-socket/Socket>[src]
presence: PresenceOptionsinterface PresenceOptionsdetritus-client-socket/PresenceOptions | null = null[src]
socket: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket | null = null[src]
url: URL | null = null[src]

Methods

setState(value: SocketStatesenum SocketStatesdetritus-client-socket/SocketStates): void[src]
makePresence(
options: PresenceOptionsinterface PresenceOptionsdetritus-client-socket/PresenceOptions = {}
): RawPresenceinterface RawPresencedetritus-client-socket/RawPresence[src]
getIdentifyData(): IdentifyDatainterface IdentifyDatadetritus-client-socket/IdentifyData[src]
getResumeData(): ResumeDatainterface ResumeDatadetritus-client-socket/ResumeData[src]
cleanup(code?: string | number, reason?: string): void[src]
connect(url?: null | string | URL): void[src]
decode(data: any, uncompressed: boolean = false): any[src]
disconnect(
code: number = SocketCloseCodes.NORMALenum SocketCloseCodesdetritus-client-socket/SocketCloseCodes,
reason?: string
): void[src]
handle(data: any, uncompressed: boolean = false): void[src]
handleDispatch(name: string, data: any): void[src]
kill(error?: Errorexternal Error): void[src]
onClose(
target: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket,
code?: number,
reason?: string
): void[src]
onError(target: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket, error: Errorexternal Error): void[src]
onMessage(target: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket, data: any): void[src]
onOpen(target: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket): void[src]
ping(timeout?: number): Promise<any>external Promise[src]
send(
op: number,
d: any,
callback?: Functionexternal Function,
direct: boolean = false
): void[src]
heartbeat(fromInterval: boolean = false): void[src]
setHeartbeat(data: Hellointerface Hellodetritus-client-socket/GatewayPackets/Hello): void[src]
identifyTry(): Promise<void>external Promise[src]
callConnect(channelId: string, callback?: Functionexternal Function): void[src]
guildStreamCreate(
guildId: string,
options: {channelId: string, preferredRegion?: string},
callback?: Functionexternal Function
): void[src]
lobbyConnect(
lobbyId: string,
lobbySecret: string,
callback?: Functionexternal Function
): void[src]
lobbyDisconnect(lobbyId: string, callback?: Functionexternal Function): void[src]
lobbyVoiceStatesUpdate(
voiceStates: Array<{
lobbyId: string,
selfDeaf: boolean,
selfMute: boolean
}>external Array,
callback?: Functionexternal Function
): void[src]
requestGuildMembers(
guildIds: Array<string>external Array | string,
options: {
limit: number,
nonce?: string,
presences?: boolean,
query: string,
userIds?: Array<string>external Array
},
callback?: Functionexternal Function
): void[src]
requestApplicationCommands(
guildId: string,
options: {
applicationId?: string,
applications: boolean,
limit?: number,
nonce: string,
offset?: number,
query?: string
}
): void[src]
setPresence(
options: PresenceOptionsinterface PresenceOptionsdetritus-client-socket/PresenceOptions = {},
callback?: Functionexternal Function
): void[src]
streamDelete(streamKey: string, callback?: Functionexternal Function): void[src]
streamPing(streamKey: string, callback?: Functionexternal Function): void[src]
streamSetPaused(
streamKey: string,
paused: boolean,
callback?: Functionexternal Function
): void[src]
streamWatch(streamKey: string, callback?: Functionexternal Function): void[src]
syncGuild(
guildIds: Array<string>external Array,
callback?: Functionexternal Function
): void[src]
updateGuildSubscriptions(
guildId: string,
options: {
activities?: boolean,
channels?: { [key: string]: Array<[number, number]>external Array},
members?: Array<string>external Array,
typing?: boolean
} = {},
callback?: Functionexternal Function
): void[src]
voiceServerPing(callback?: Functionexternal Function): void[src]
voiceStateUpdate(
guildId: null | string = null,
channelId: null | string = null,
options: {
preferredRegion?: string,
selfDeaf?: boolean,
selfMute?: boolean,
selfVideo?: boolean
} = {},
callback?: Functionexternal Function
): void[src]
voiceConnect(
guildId?: null | string,
channelId?: null | string,
options: {
forceMode?: string,
receive?: boolean,
selfDeaf?: boolean,
selfMute?: boolean,
selfVideo?: boolean,
timeout?: number,
video?: boolean
} = {receive: true, timeout: number}
): Promise<Socketclass Socketdetritus-client-socket/Socket | null>external Promise[src]
on(event: string | symbol, listener: (...args: any[]) => void): Socketclass Socketdetritus-client-socket/Socket[src]
9 more overloads
on(
event: "close",
listener: (payload: {code: number, reason: string}) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(event: "killed", listener: () => any): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "open",
listener: (target: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "packet",
listener: (packet: Packetinterface Packetdetritus-client-socket/GatewayPackets/Packet) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(event: "ready", listener: () => any): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "socket",
listener: (socket: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "state",
listener: (
__namedParameters: {state: SocketStatesenum SocketStatesdetritus-client-socket/SocketStates}
) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "warn",
listener: (error: Errorexternal Error) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(event: string | symbol, listener: (...args: any[]) => void): Socketclass Socketdetritus-client-socket/Socket[src]